Stop shipping grafana-based image #7567
Conversation
Fixes #6045 #7358 With this change we stop building a Grafana-based image preloaded with the Linkerd Grafana dashboards. Instead, we'll recommend users to install Grafana by themselves, and we provide a file `grafana/values.yaml` with a default config that points to all the same Grafana dashboards we had, which are now hosted in https://grafana.com/orgs/linkerd/dashboards . The new file `grafana/README.md` contains instructions for installing the official Grafana Helm chart, and mentions other available methods. The `grafana.enabled` flag has been removed, and `grafanaUrl` has been moved to `grafana.url`. This will help consolidating other grafana settings that might emerge, in particular when #7429 gets addressed. ## Dashboards definitions changes The dashboard definitions under `grafana/dashboards` (which should be kept in sync with what's published in https://grafana.com/orgs/linkerd/dashboards), got updated, adding the `__inputs`, `__elements` and `__requires` entries at the beginning, that were required in order to be published.
…ssing it, and have 'linkerd viz' install use --prune
There was a problem hiding this comment.
Should the grafana README include instructions for how to publish dashboard changes to grafana.com?
Additionally, it would be nice to have some more detailed step-by-step instructions for installing grafana, and configuring linkerd-viz to use it but that probably belongs as a doc on the website.
I've just added the location in grafana.com at the end of the README, where dashboards can be managed.
Indeed. I'll followup with doc updates. |
There was a problem hiding this comment.
This change looks great, and happy that we have one less thing to worry about already!
My suggestion would be to have
{{- if .Values.grafana.url }}
- -grafana-addr={{.Values.grafana.url}}
{{- end}}
in the web.yaml and have grafana.url set to be empty by default. Because with the default install, we can't be sure where their grafana would be, and it probably won't be at grafana.grafana and thus renderinng errors when users click the grafana icon in the dashboard. Instead we should not display grafana icon by default, and have it only when grafana.url is set explicitly by the user. We can also update the docs stating this. WDYT?
Makes sense 👍 |
Followup to linkerd/linkerd2#7567 This is branched off of `alpeb/2.12`. - Upgraded 2.12 upgrade notes, to explain linkerd viz no longer installs a grafana instance - Created tasks/grafana.md explaining how to install and configure grafana and hookup the linkerd grafana dashboards
* Docs for Grafana removal Followup to linkerd/linkerd2#7567 This is branched off of `alpeb/2.12`. - Upgraded 2.12 upgrade notes, to explain linkerd viz no longer installs a grafana instance - Created tasks/grafana.md explaining how to install and configure grafana and hookup the linkerd grafana dashboards - Add section for off-cluster Grafana
Fixes #6045 #7358
With this change we stop building a Grafana-based image preloaded with the Linkerd Grafana dashboards.
Instead, we'll recommend users to install Grafana by themselves, and we provide a file
grafana/values.yamlwith a default config that points to all the same Grafana dashboards we had, which are now hosted in https://grafana.com/orgs/linkerd/dashboards .The new file
grafana/README.mdcontains instructions for installing the official Grafana Helm chart, and mentions other available methods.The
grafana.enabledflag has been removed, andgrafanaUrlhas been moved tografana.url. This will help consolidating other grafana settings that might emerge, in particular when #7429 gets addressed.Dashboards definitions changes
The dashboard definitions under
grafana/dashboards(which should be kept in sync with what's published in https://grafana.com/orgs/linkerd/dashboards), got updated, adding the__inputs,__elementsand__requiresentries at the beginning, that were required in order to be published.Labels additions
Added the
linkerd.io/extension: vizlabel to some resources that were missing it. That way we can safely uselinkerd viz install --prune -l linkerd.io/extension=vizintests/integration/install_test.go, required for the grafana resources to be removed in theupgrade-edge|stabletests.